home *** CD-ROM | disk | FTP | other *** search
/ Fritz: All Fritz / All Fritz.zip / All Fritz / FILES / UTILHIVE / PKLT10.LZH / DIRX.DOC < prev    next >
Text File  |  1991-07-20  |  15KB  |  347 lines
  1.                         July 20, 1991
  2.  
  3.  
  4. DirX 1.05 - Directory of eXecutables.  Files compressed with AXE, DIET,
  5. EXEPACK, ICE, LEXEM, LZEXE, PKLITE, SCRNCH, SHRINK and TINYPROG are
  6. displayed in the left window.  Uncompressed COM/EXE files are displayed in
  7. the right window.  Compress and uncompress individual and groups of files
  8. from within the program.  Navigate between drives/directories by pointing
  9. and shooting.  New:  Network support and extended syntax for DIRX.CFG.
  10.  
  11. Contents:
  12. =========
  13. Purpose
  14. Displayed data
  15. Syntax
  16. Switches
  17. Configuration
  18. Commands
  19. Pull-down menus
  20. Closing remarks
  21.  
  22. Purpose:
  23. ========
  24. To provide a simple means of easily showing which files have and have not
  25. been compressed with an executable file compressor.  It allows for easy
  26. compression and uncompression of individual and groups of files by
  27. user-selectable compression/uncompression programs.
  28.  
  29. DirX is a free program.
  30.  
  31. Displayed data:
  32. ===============
  33. When the program is started, two windows pop up displaying any compressed
  34. files and/or directories on the left and any non-compressed files on the
  35. right.  The window on the left is slightly wider to allow an abbreviated
  36. three-character identifier to precede each filename - currently "axe",
  37. "die", "epk", "ice", "lex", "lze", "pkl", "scr", "shr" or "tny" for files
  38. compressed with AXE, DIET, EXEPACK, ICE, LEXEM, LZEXE, PKLITE, SCRNCH,
  39. SHRINK or TINYPROG, respectively.
  40.  
  41. In addition to the file name, and type in the compressed window, the
  42. default display also shows the file size, date and time for each file.
  43. Using the "Toggle" command, the current window can be set to show any
  44. special characteristics ("Special"), file attributes ("Attr"), the probable
  45. correct extension for the file name if it has been misnamed ("Mis") and
  46. which version of the compressor was used in the case of DIET, LZEXE, PKLITE
  47. and TINYPROG files.
  48.  
  49. Please note that as DIET, at least up until version 1.10, does not
  50. explicitly store the version number, any version number greater than 1.00
  51. can only be interpreted in the "greater than or equal to" sense.  Thus a
  52. reading of "1.01" means that a version of DIET equal to 1.01, or higher,
  53. was used to compress a file.
  54.  
  55. Files compressed with PKLITE Professional's extra-compression option have
  56. an 'e' appended to the version number.
  57.  
  58. Special characteristics displayed using the Toggle command are as follows:
  59. For the Compressed window, "dat" for "data" files (non-executables)
  60. compressed with DIET.  For the Uncompressed window, "ovl" for possible
  61. executables containing overlays, "win" for Windows/OS2 executables and
  62. "lhi" for LoadHi executables.
  63.  
  64. The program attempts to sense the type of display used and adjust color
  65. appropriately.  However, if the user has a color graphics card, but no
  66. color monitor, the display may be improved by using the DOS command "MODE
  67. BW80".  Conversely, if you do have a color monitor, but the program
  68. displays in "black and white", try using "MODE CO80".
  69.  
  70. Alternatively, two switches are available from the command line to force
  71. black-and-white and color modes.  See "Switches" below.
  72.  
  73. EGA/43- and VGA/50-line modes are supported.  At program startup, an
  74. attempt is made to detect the actual number of lines on the screen, up to a
  75. maximum of 50, and to adjust the display accordingly.
  76.  
  77. Syntax:
  78. =======
  79.      Usage:  DIRX [switches] [d:][path][filespec] [switches]
  80.  
  81. In the above syntax, if no argument follows the program name, the current
  82. default directory is searched, which is equivalent to "DIRX *.*".  If no
  83. file extension is specified, all extensions are searched.
  84.  
  85. Switches:
  86. =========
  87.      -a:  display Alternate info for both windows on startup.  Simpler than
  88.           selecting each window in turn from within the program and using
  89.           the Toggle command twice.
  90.  
  91.      -b:  force Black-and-white mode.  Provided as an alternative to using
  92.           DOS's "MODE BW80" command.
  93.  
  94.      -c:  force Color mode.  Provided as an alternatative to using DOS's
  95.           "MODE CO80" command.
  96.  
  97. Either '/' or '-' may be used to specify switches.
  98.  
  99. Entering an invalid switch causes the program display a brief help screen
  100. then exit.
  101.  
  102. Examples:
  103.  
  104.      DIRX /h
  105.      DIRX -?
  106.  
  107. Configuration:
  108. ==============
  109. The user may create or edit a file named DIRX.CFG using an editor or word
  110. processor which can save pure ASCII text files.  DIRX.CFG should reside on
  111. the PATH, or in the current directory, when DirX is run.
  112.  
  113. In searching your path for DIRX.CFG, only the first 127 characters of the
  114. PATH statement are significant.  For "extended" paths (PATH statements
  115. longer than 127 characters), please make sure that the path containing
  116. DIRX.CFG is completely specified before the 127-character limit has been
  117. reached.
  118.  
  119. The contents of DIRX.CFG allow the user to specify which program will be
  120. invoked for compressing uncompressed files and which program(s) to use for
  121. uncompressing the related types of compressed files (axe, die, epk, ice,
  122. lex, lze, pkl, scr, shr, tny).  Although the syntax of DIRX.CFG allows for
  123. uncompression programs for any of the supported formats, the related
  124. uncompressing program for a particular type may not exist at the present
  125. time.
  126.  
  127. The syntax for specifying the *single* compression program is:
  128.  
  129. /C="prognam {filespec | options}"
  130.  
  131. Where:  "prognam" is the name of the program to execute
  132.         "filespec" are format specifiers passed to "prognam" as filenames
  133.         "options" are usually switches passed to "prognam"
  134.  
  135. "filespec" may be created by a concatenation of the "%f" and "%e" format
  136. specifiers.
  137.  
  138. If "filename.ext" is a target file, then %f represents the "filename"
  139. portion of the complete filename, and %e represents the ".ext" part.
  140.  
  141. If no format specifiers are detected, then the current target filename is
  142. simply appended to the end of the "prognam ... " string.  This is for
  143. compatibility with DIRX.CFG files created for use with versions of DirX
  144. prior to 1.05.
  145.  
  146. Specific examples follow:
  147.  
  148. /C="PKLITE %f%e"
  149.  
  150. /C="AXE %f%e -n"
  151.  
  152. /C="EXEPACK %f%e %f.EPK"
  153.  
  154. /C="DIET"    <- older syntax, but still works
  155.  
  156. If DIRX.CFG contains more than one line with the correct syntax for
  157. specifying the compression program, the last one encountered before end of
  158. file will be used.
  159.  
  160. The default command for specifying the method of compression may be
  161. temporarily overridden from within the program.  More about this later in
  162. the "Commands" section.
  163.  
  164. The syntax for specifying the uncompression program(s) is:
  165.  
  166. /U<xxx>="prognam {filespec | options}"
  167.  
  168. Where <xxx> is "axe", "die", "epk", "ice", "lex", "lze", "pkl", "scr",
  169. "shr" or "tny" for files compressed with AXE, DIET, EXEPACK, ICE, LEXEM,
  170. LZEXE, PKLITE, SCRNCH, SHRINK or TINYPROG, respectively.
  171.  
  172. "prognam", "filespec" and "options" have the same meanings as discussed
  173. above for specifying the compress command.
  174.  
  175. Specific examples follow:
  176.  
  177. /Upkl="PKLITE %f%e -x"
  178.  
  179. /Udie="DIET -ra %f%e"
  180.  
  181. /Uepk="UPACKEXE %f%e"
  182.  
  183. If DIRX.CFG contains more than one line with the correct syntax for
  184. specifying the uncompression program for the related type of compressed
  185. file, the last one encountered before end of file will be used.
  186.  
  187. In the above syntax for DIRX.CFG, neither leading and trailing spaces, nor
  188. any other extraneous characters are allowed.  Lines with invalid syntax,
  189. including invalid format specifiers, are simply ignored.  This may actually
  190. be used to advantage, as shown in the *sample* DIRX.CFG file, where the
  191. single quote character is used to "comment-out" some of the non-applicable
  192. lines, but where the user may want to retain these lines to save retyping
  193. should he/she want to later change which is the default compression
  194. program, for example.
  195.  
  196. The sample DIRX.CFG file is included in the distribution archive, which the
  197. user may edit to "customize" DirX's behavior.
  198.  
  199. Commands:
  200. =========
  201. The current or active window is the one with the solid frame.  Within the
  202. active window, <Home>, <End>, <PgUp>, <PgDn>, <UpArrow> and <DownArrow> may
  203. be used to navigate.  The <Tab> and right/left arrow keys will toggle the
  204. active window between the left and right panels.
  205.  
  206. If any directories are displayed in the left (Compressed) window, moving
  207. the file selection bar (highlight) over that directory and pressing
  208. <Return> will change the directory being viewed.  The file lists will be
  209. updated automatically.
  210.  
  211. Two shortcut keys are available for navigating directories while in the
  212. Compressed window:
  213.  
  214. "Ctrl \" changes the current directory to the root directory - similar to
  215. "CD \" at the DOS level.
  216.  
  217. "Ctrl <PgUp>" changes the current directory to the parent directory -
  218. similar to "CD .." from DOS.
  219.  
  220. To change the current default drive from within the program, use either
  221. "Alt <F1>" or "Alt <F2>".  A window indicating valid drives will pop up,
  222. allowing the user to select another drive by moving the highlight with the
  223. left and right arrow keys, then pressing <Return> to select the new drive.
  224. As an alternative, you may also type the letter of the drive.  Press <Esc>
  225. to leave the default drive unchanged.  The drive changing feature is only
  226. valid when using versions of DOS numbered 3.0 or higher.
  227.  
  228. Pressing <F1> or the letter 'H' will display a brief help screen
  229. summarizing commonly used commands.  Press any key to close the help
  230. window.
  231.  
  232. Pressing <F3> or the letter 'D' will turn Directories-only mode on.  To
  233. turn Directories-only mode off, press <F3> or 'D' a second time.  (This
  234. feature was added by user request to speed up navigation on a relatively
  235. slow machine.)
  236.  
  237. Pressing <F4> or the letter 'T' will toggle the active window's display to
  238. show additional information on the files being displayed, as previously
  239. described in the "Displayed data" section above.
  240.  
  241. Pressing <F6> or the letter 'M' when no files have been selected will cause
  242. the Move command to act on the currently highlighted file.  If any files
  243. have been selected, the Move command acts on the selected files.
  244.  
  245. If the Move command is given while in the "Compressed" window, the DOS
  246. command "<uncompPrognam> <filename>" is executed for each selected file,
  247. where <uncompPrognam> is the name of the uncompression program and
  248. <filename> is the name of the file to uncompress.
  249.  
  250. If the Move command is given while in the "Uncompressed" window, the DOS
  251. command "<compPrognam> <filename>" is executed for each selected file,
  252. where <compPrognam> is the name of the compression program and <filename>
  253. is the name of the file to compress.
  254.  
  255. Pressing "Alt <F6>" or "Alt M" from either the Compressed or Uncompressed
  256. window will open an input window which will allow the user to temporarily
  257. "Alter", or override, the method of compression currently defined in
  258. DIRX.CFG, on the fly, from within DirX.
  259.  
  260. For compressing/uncompressing to work, the commands <compPrognam> and/or
  261. <uncompPrognam> should either be available in a directory included in the
  262. PATH environment variable, or in the current directory.  Tip:  Either of
  263. these "programs" may be batch files.
  264.  
  265. Files may be selected, or tagged, either individually or by wildcard
  266. selection.  The <Ins> key may be used as a toggle to select and unselect
  267. individual files.  Pressing <Ins> on an unselected file selects it.
  268. Pressing <Ins> on a selected file unselects it.  To select a group of files
  269. using DOS-type wildcards, press the plus ('+') key.  This opens up an input
  270. window into which a file specification may be entered.  To unselect a group
  271. of files, press the minus ('-').  This opens up an input window similar to
  272. the one for selection.  The suggested keys are the gray plus and minus keys
  273. found near the numeric keypad of many keyboards.
  274.  
  275. Pressing <F7> or the letter 'S' will open an input window for the user to
  276. enter a file specification to search for within the current window.  If
  277. wildcards are used, and the Search command is repeatedly invoked without
  278. changing the search specification, the program will cycle through all
  279. matching file names.
  280.  
  281. Pressing <F9> or the letter 'P' or '/' will invoke the pull-down menu
  282. system.
  283.  
  284. Pressing <Esc>, <F10> or the letter 'Q' will exit the program.
  285.  
  286. Pull-down menus:
  287. ================
  288. The pull-down menu system duplicates in functionality many of the commands
  289. already described in the Commands section.  The purpose of this menu system
  290. is to de-emphasize the use of function keys and cryptic Alt- and Ctrl-key
  291. sequences when adding new commands in the future.
  292.  
  293. The Move command, invoked by function key, is replaced by two separate
  294. commands in the pull-down menu system.  These are the "Compress" and
  295. "Uncompress" commands, listed under the "File" submenu.
  296.  
  297. For the Uncompress command to work, the Compressed window must be the
  298. current one.  This command is equivalent to using the Move command while in
  299. the Compressed window.
  300.  
  301. The Compress command, depending on which window is active, can act on files
  302. in *either* the Compressed or Uncompressed windows.  The purpose of
  303. allowing the user to *attempt to* compress already compressed files
  304. (something that is available from the command line anyway) is to facilitate
  305. experimentation on the effects of compression by a variety of methods -
  306. compressing files already compressed with EXEPACK, for example.
  307.  
  308. Closing remarks:
  309. ================
  310. If you find this program useful, E-mail sent to me at my CompuServe ID, or
  311. a postcard or letter mailed to my P.O. Box, communicating this to me will
  312. always be appreciated.
  313.  
  314. While comments and suggestions on my freeware are welcome and encouraged,
  315. my personal preference is for small, simple utilities.  As I take user
  316. feedback collectively as a pool from which to draw for ideas, please do not
  317. be offended if I don't incorporate your particular suggestion(s), as yours
  318. may possibly be one of many I receive, and my programs cannot be all things
  319. to all people.  In any case, please bear in mind that I'm currently
  320. employed full-time in a salaried, non-programming position, and that I'm
  321. only one person "supporting" my free utilities on my spare time.
  322.  
  323. I will personally upload new public releases of DirX first to CompuServe's
  324. IBM Sys/Utilities Forum (GO IBMSYS), where the files are posted in Library
  325. 0 (New Uploads) for a period of 30 days before they are moved into Library
  326. 6 (File Utilities).
  327.  
  328. Only *after* the distribution archives have been made available for public
  329. downloading on IBMSYS might I then personally upload copies of these files
  330. to other forums, networks or BBS's, if at all.  Downloaders are welcome to
  331. distribute copies of the distribution archives to other networks and BBS's.
  332. My upload policy is subject to change in the future.
  333.  
  334. I may be reached at the addresses below:
  335.  
  336.  
  337.                 By conventional mail:
  338.                 ---------------------
  339.                 Raymond T. Kaya
  340.                 P. O. Box 1436
  341.                 Honolulu, HI  96806
  342.  
  343.  
  344.                 By electronic mail:
  345.                 -------------------
  346.                 CompuServe:  71230,2500
  347.